using System.Runtime.CompilerServices;

//
// * Copyright (c) 2002-2009 "Neo Technology,"
// *     Network Engine for Objects in Lund AB [http://neotechnology.com]
// *
// * This file is part of Neo4j.
// * 
// * Neo4j is free software: you can redistribute it and/or modify
// * it under the terms of the GNU Affero General Public License as
// * published by the Free Software Foundation, either version 3 of the
// * License, or (at your option) any later version.
// * 
// * This program is distributed in the hope that it will be useful,
// * but WITHOUT ANY WARRANTY; without even the implied warranty of
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// * GNU Affero General Public License for more details.
// * 
// * You should have received a copy of the GNU Affero General Public License
// * along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
namespace org.neo4j.kernel.impl.persistence
{

///
/// <summary> * This class represents the <seealso cref="IdGenerator"/> module. It receives lifecycle
/// * events from the module framework and supports configuration of the
/// * IdGenerator.
/// * <P>
/// * Generally, configuration of the IdGenerator must be done before the first
/// * invocation of the <seealso cref="#start"/> method. This is because the IdGenerator does
/// * not currently support the modular start/stop/reload operations and there is
/// * no way to guarantee consistent behavior if the IdGenerator is not halted
/// * during reconfiguration.
/// * <P> </summary>
/// * <seealso cref= org.neo4j.kernel.impl.persistence.IdGenerator </seealso>
/// 
	public class IdGeneratorModule
	{
		private const string MODULE_NAME = "IdGeneratorModule";

		private PersistenceSource persistenceSource = null;
		private readonly IdGenerator idGenerator;

		public IdGeneratorModule()
		{
			this.idGenerator = new IdGenerator();
		}

		public virtual IdGenerator getIdGenerator()
		{
			return idGenerator;
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void init()
		{
		// Do nothing
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void start()
		{
		// Configure the IdGenerator
			idGenerator.configure(this.getPersistenceSource());
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void reload()
		{
			throw new UnsupportedOperationException("IdGenerator does not support reload");
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void stop()
		{
		// Do nothing
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void destroy()
		{
		// Do nothing
		}

		public virtual string getModuleName()
		{
			return MODULE_NAME;
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		private PersistenceSource getPersistenceSource()
		{
			return this.persistenceSource;
		}

		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void setPersistenceSourceInstance(PersistenceSource source)
		{
			this.persistenceSource = source;
		}

		public override string ToString()
		{
			return this.getModuleName();
		}
	}
}